/*
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is
 *
 * java-concurrency-presentation:
 * concurrency presentation tutorial.
 *
 * The Initial Developer of the Original Code is
 * Marco Antonio Villalobos, Jr.
 * Portions created by the Initial Developer are Copyright (C) 2010
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s): None.
 *
 * ***** END LICENSE BLOCK *****
 */

package presentation.concurrency.indexer;

import java.util.Map;
import java.util.Set;

/**
 * A document index.
 */
public interface Index {

    /**
     * Adds a word, with the name of the file, and line, to this document.
     *
     * @param word The word to add to this document.
     * @param file The file that this word belongs to.
     * @param line The line number in this file that this word belongs to.
     */
    void add(String word, String file, int line);

    /**
     * Retrieves a set of words.
     *
     * This is a set of Map entries.  Each value in the set represents a unique word.
     *
     * The map entry key is the word as a String.
     *
     * The map value is a Word data-structure that contains the word count for this word, and a set of locations of where this word can be found.
     *
     * @return A set of words.
     */
    Set<Map.Entry<String,Word>> getWords();


    /**
     * Retrieves the total non-unique word count in all the documents.
     *
     * For example, the word "apple" was found 3 times. then word count will be 3.
     *
     * @return The total non-unique word count in all the documents.
     */
    long getWordCount();
}
